<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class HostmonsterClient</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> HostmonsterClient</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">HostmonsterClient</p>
<p class="description"><p>This class will be used to manage domains of a hostmonster account</p></p>
		<p class="notes">
			Located in <a class="field" href="_hostmon_client.php.html">/hostmon_client.php</a> (line <span class="field">9</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																								<div class="method-definition">
					<img src="../media/images/Constructor.png" alt=" "/>
											<span class="method-result">HostmonsterClient</span>
										<a href="#HostmonsterClient" title="details" class="method-name">HostmonsterClient</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$dom</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dom_manager_login_url</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$dom_check_url</span> = <span class="var-default">''</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">true|false</span>
										<a href="#add_dom" title="details" class="method-name">add_dom</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$dom</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$dom_type</span> = <span class="var-default">'other'</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$owner_code</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$assign_type</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$assign_dir</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$msg</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">true|false</span>
										<a href="#check_dom" title="details" class="method-name">check_dom</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$dom_to_check</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$msg</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">NULL|array</span>
										<a href="#get_domain_list" title="details" class="method-name">get_domain_list</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$msg</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$msg</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">array</span>
										<a href="#get_dom_account" title="details" class="method-name">get_dom_account</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#get_dom_check_url" title="details" class="method-name">get_dom_check_url</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#get_dom_manager_login_url" title="details" class="method-name">get_dom_manager_login_url</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">error</span>
										<a href="#get_error_message" title="details" class="method-name">get_error_message</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">errno</span>
										<a href="#get_error_number" title="details" class="method-name">get_error_number</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">true|false</span>
										<a href="#login_domain_manager" title="details" class="method-name">login_domain_manager</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#set_dom_account" title="details" class="method-name">set_dom_account</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$dom_account</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#set_dom_check_url" title="details" class="method-name">set_dom_check_url</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#set_dom_manager_login_url" title="details" class="method-name">set_dom_manager_login_url</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
													<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodHostmonsterClient" id="HostmonsterClient"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Constructor.png" />
		<span class="method-title">Constructor HostmonsterClient</span> (line <span class="line-number">140</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
	
	<div class="method-signature">
		<span class="method-result">HostmonsterClient</span>
		<span class="method-name">
			HostmonsterClient
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$dom</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dom_manager_login_url</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$dom_check_url</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dom</span><span class="var-description">: the domain to login</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$password</span><span class="var-description">: the password of the domain</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dom_manager_login_url</span><span class="var-description">: the url used login the domain manager page</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dom_check_url</span><span class="var-description">: the url used to check whether a domain exists.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodadd_dom" id="add_dom"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">add_dom</span> (line <span class="line-number">293</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add domain function</p>
	<ul class="tags">
				<li><span class="field">return:</span> true if added, false otherwise         *</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">true|false</span>
		<span class="method-name">
			add_dom
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$dom</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$dom_type</span> = <span class="var-default">'other'</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$owner_code</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$assign_type</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$assign_dir</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$msg</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dom_type</span><span class="var-description">: the domain type to add, there are two acceptable value local|other</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dom</span><span class="var-description">: the domain to add</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$owner_code</span><span class="var-description">: domain owner code(epp code)</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$assign_type</span><span class="var-description">: the assign type, there are two valid values addon|parked</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$assign_dir</span><span class="var-description">: the directory to assign</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">&$msg</span><span class="var-description">: output message</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcheck_dom" id="check_dom"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">check_dom</span> (line <span class="line-number">240</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check whether a domain belongs to hostmonster</p>
	<ul class="tags">
				<li><span class="field">return:</span> true if the domain is currently pointing to the hostmonster</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">true|false</span>
		<span class="method-name">
			check_dom
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$dom_to_check</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">&$msg</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dom_to_check</span><span class="var-description">: the domain name to check</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">&$msg</span><span class="var-description">: the return message</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_domain_list" id="get_domain_list"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_domain_list</span> (line <span class="line-number">194</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This function get the domain list of the given account</p>
	<ul class="tags">
				<li><span class="field">return:</span> NULL if there is no domain or there is an error occurred</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">NULL|array</span>
		<span class="method-name">
			get_domain_list
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$msg</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$msg</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$msg</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$msg</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_dom_account" id="get_dom_account"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_dom_account</span> (line <span class="line-number">101</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the domain account</p>
	<ul class="tags">
				<li><span class="field">return:</span> the dom_account array</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			get_dom_account
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_dom_check_url" id="get_dom_check_url"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_dom_check_url</span> (line <span class="line-number">72</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Function to get the dom_check_url value</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			get_dom_check_url
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_dom_manager_login_url" id="get_dom_manager_login_url"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_dom_manager_login_url</span> (line <span class="line-number">92</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Function to get the dom_manager_login_url</p>
	<ul class="tags">
				<li><span class="field">return:</span> the dom_manager_login_url</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_dom_manager_login_url
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_error_message" id="get_error_message"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_error_message</span> (line <span class="line-number">128</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the error message</p>
	
	<div class="method-signature">
		<span class="method-result">error</span>
		<span class="method-name">
			get_error_message
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_error_number" id="get_error_number"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">get_error_number</span> (line <span class="line-number">119</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the error number</p>
	
	<div class="method-signature">
		<span class="method-result">errno</span>
		<span class="method-name">
			get_error_number
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodlogin_domain_manager" id="login_domain_manager"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">login_domain_manager</span> (line <span class="line-number">169</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Login the domain manager</p>
	<ul class="tags">
				<li><span class="field">return:</span> if successfully logged in, if failed set errno and error message</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">true|false</span>
		<span class="method-name">
			login_domain_manager
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodset_dom_account" id="set_dom_account"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">set_dom_account</span> (line <span class="line-number">110</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the domain account</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_dom_account
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$dom_account</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$dom_account</span><span class="var-description">: *</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_dom_check_url" id="set_dom_check_url"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">set_dom_check_url</span> (line <span class="line-number">62</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Function to set the dom_check_url value</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_dom_check_url
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$url</span><span class="var-description">: the url to be set</span>			</li>
				</ul>
		
			
	</div>
<a name="methodset_dom_manager_login_url" id="set_dom_manager_login_url"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">set_dom_manager_login_url</span> (line <span class="line-number">81</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Function to set the dom_manager_login_url</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_dom_manager_login_url
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$url</span><span class="var-description">: the url to be set</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Fri, 16 Jan 2009 16:01:24 +0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
	</p>
	</div></body>
</html>